POST
/
public
/
v1
/
toptimize
/
forecasting
/
inventory
curl --request POST \
  --url https://api.topsort.com/public/v1/toptimize/forecasting/inventory \
  --header 'Content-Type: application/json' \
  --data '{
  "inventory": [
    {
      "inventoryType": "category",
      "inventoryValue": "<string>"
    }
  ],
  "timeWindow": 7
}'
[
  {
    "dailyForecasts": [
      {
        "forecastDate": "2025-01-15",
        "metrics": [
          {
            "metricName": "total_auctions",
            "values": {
              "forecastIntervalMax": 13200,
              "forecastIntervalMin": 11800,
              "forecastValue": 12500
            }
          },
          {
            "metricName": "total_slots",
            "values": {
              "forecastIntervalMax": 26500,
              "forecastIntervalMin": 23500,
              "forecastValue": 25000
            }
          },
          {
            "metricName": "total_winners",
            "values": {
              "forecastIntervalMax": 9300,
              "forecastIntervalMin": 8200,
              "forecastValue": 8750
            }
          },
          {
            "metricName": "total_impressions",
            "values": {
              "forecastIntervalMax": 19900,
              "forecastIntervalMin": 17600,
              "forecastValue": 18750
            }
          },
          {
            "metricName": "total_clicks",
            "values": {
              "forecastIntervalMax": 4000,
              "forecastIntervalMin": 3500,
              "forecastValue": 3750
            }
          },
          {
            "metricName": "avg_cpc",
            "values": {
              "forecastIntervalMax": 3,
              "forecastIntervalMin": 2.7,
              "forecastValue": 2.85
            }
          },
          {
            "metricName": "avg_ctr",
            "values": {
              "forecastIntervalMax": 0.22,
              "forecastIntervalMin": 0.18,
              "forecastValue": 0.2
            }
          },
          {
            "metricName": "slot_occupancy",
            "values": {
              "forecastIntervalMax": 0.75,
              "forecastIntervalMin": 0.65,
              "forecastValue": 0.7
            }
          },
          {
            "metricName": "total_capacity",
            "values": {
              "forecastIntervalMax": 132000,
              "forecastIntervalMin": 118000,
              "forecastValue": 125000
            }
          },
          {
            "metricName": "occupied_capacity",
            "values": {
              "forecastIntervalMax": 93000,
              "forecastIntervalMin": 82000,
              "forecastValue": 87500
            }
          }
        ]
      }
    ],
    "inventoryType": "category",
    "inventoryValue": "electronics"
  },
  {
    "dailyForecasts": [
      {
        "forecastDate": "2025-01-15",
        "metrics": [
          {
            "metricName": "total_auctions",
            "values": {
              "forecastIntervalMax": 13200,
              "forecastIntervalMin": 11800,
              "forecastValue": 12500
            }
          },
          {
            "metricName": "total_slots",
            "values": {
              "forecastIntervalMax": 26500,
              "forecastIntervalMin": 23500,
              "forecastValue": 25000
            }
          },
          {
            "metricName": "total_winners",
            "values": {
              "forecastIntervalMax": 9300,
              "forecastIntervalMin": 8200,
              "forecastValue": 8750
            }
          },
          {
            "metricName": "total_impressions",
            "values": {
              "forecastIntervalMax": 19900,
              "forecastIntervalMin": 17600,
              "forecastValue": 18750
            }
          },
          {
            "metricName": "total_clicks",
            "values": {
              "forecastIntervalMax": 4000,
              "forecastIntervalMin": 3500,
              "forecastValue": 3750
            }
          },
          {
            "metricName": "avg_cpc",
            "values": {
              "forecastIntervalMax": 3,
              "forecastIntervalMin": 2.7,
              "forecastValue": 2.85
            }
          },
          {
            "metricName": "avg_ctr",
            "values": {
              "forecastIntervalMax": 0.22,
              "forecastIntervalMin": 0.18,
              "forecastValue": 0.2
            }
          },
          {
            "metricName": "slot_occupancy",
            "values": {
              "forecastIntervalMax": 0.75,
              "forecastIntervalMin": 0.65,
              "forecastValue": 0.7
            }
          },
          {
            "metricName": "total_capacity",
            "values": {
              "forecastIntervalMax": 132000,
              "forecastIntervalMin": 118000,
              "forecastValue": 125000
            }
          },
          {
            "metricName": "occupied_capacity",
            "values": {
              "forecastIntervalMax": 93000,
              "forecastIntervalMin": 82000,
              "forecastValue": 87500
            }
          }
        ]
      }
    ],
    "inventoryType": "search",
    "inventoryValue": "smartphone"
  }
]

Body

application/json

Request model for batch inventory forecasts.

Response

200
application/json

Successful Response

The response is of type InventoryForecast · object[].